//! ELF definitions.

//!

//! These definitions are independent of read/write support, although we do implement

//! some traits useful for those.

//!

//! This module is the equivalent of /usr/include/elf.h, and is based heavily on it.

#![allow(clippy::identity_op)]

use crate::endian::{Endian, U32Bytes, U64Bytes, I32, I64, U16, U32, U64};

use crate::pod::Pod;

/// The header at the start of every 32-bit ELF file.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct FileHeader32<E: Endian> {

    /// Magic number and other information.

    pub e_ident: Ident,

    /// Object file type. One of the `ET_*` constants.

    pub e_type: U16<E>,

    /// Architecture. One of the `EM_*` constants.

    pub e_machine: U16<E>,

    /// Object file version. Must be `EV_CURRENT`.

    pub e_version: U32<E>,

    /// Entry point virtual address.

    pub e_entry: U32<E>,

    /// Program header table file offset.

    pub e_phoff: U32<E>,

    /// Section header table file offset.

    pub e_shoff: U32<E>,

    /// Processor-specific flags.

    ///

    /// A combination of the `EF_*` constants.

    pub e_flags: U32<E>,

    /// Size in bytes of this header.

    pub e_ehsize: U16<E>,

    /// Program header table entry size.

    pub e_phentsize: U16<E>,

    /// Program header table entry count.

    ///

    /// If the count is greater than or equal to `PN_XNUM` then this field is set to

    /// `PN_XNUM` and the count is stored in the `sh_info` field of section 0.

    pub e_phnum: U16<E>,

    /// Section header table entry size.

    pub e_shentsize: U16<E>,

    /// Section header table entry count.

    ///

    /// If the count is greater than or equal to `SHN_LORESERVE` then this field is set to

    /// `0` and the count is stored in the `sh_size` field of section 0.

    /// first section header.

    pub e_shnum: U16<E>,

    /// Section header string table index.

    ///

    /// If the index is greater than or equal to `SHN_LORESERVE` then this field is set to

    /// `SHN_XINDEX` and the index is stored in the `sh_link` field of section 0.

    pub e_shstrndx: U16<E>,

}

/// The header at the start of every 64-bit ELF file.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct FileHeader64<E: Endian> {

    /// Magic number and other information.

    pub e_ident: Ident,

    /// Object file type. One of the `ET_*` constants.

    pub e_type: U16<E>,

    /// Architecture. One of the `EM_*` constants.

    pub e_machine: U16<E>,

    /// Object file version. Must be `EV_CURRENT`.

    pub e_version: U32<E>,

    /// Entry point virtual address.

    pub e_entry: U64<E>,

    /// Program header table file offset.

    pub e_phoff: U64<E>,

    /// Section header table file offset.

    pub e_shoff: U64<E>,

    /// Processor-specific flags.

    ///

    /// A combination of the `EF_*` constants.

    pub e_flags: U32<E>,

    /// Size in bytes of this header.

    pub e_ehsize: U16<E>,

    /// Program header table entry size.

    pub e_phentsize: U16<E>,

    /// Program header table entry count.

    ///

    /// If the count is greater than or equal to `PN_XNUM` then this field is set to

    /// `PN_XNUM` and the count is stored in the `sh_info` field of section 0.

    pub e_phnum: U16<E>,

    /// Section header table entry size.

    pub e_shentsize: U16<E>,

    /// Section header table entry count.

    ///

    /// If the count is greater than or equal to `SHN_LORESERVE` then this field is set to

    /// `0` and the count is stored in the `sh_size` field of section 0.

    /// first section header.

    pub e_shnum: U16<E>,

    /// Section header string table index.

    ///

    /// If the index is greater than or equal to `SHN_LORESERVE` then this field is set to

    /// `SHN_XINDEX` and the index is stored in the `sh_link` field of section 0.

    pub e_shstrndx: U16<E>,

}

/// Magic number and other information.

///

/// Contained in the file header.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Ident {

    /// Magic number. Must be `ELFMAG`.

    pub magic: [u8; 4],

    /// File class. One of the `ELFCLASS*` constants.

    pub class: u8,

    /// Data encoding. One of the `ELFDATA*` constants.

    pub data: u8,

    /// ELF version. Must be `EV_CURRENT`.

    pub version: u8,

    /// OS ABI identification. One of the `ELFOSABI*` constants.

    pub os_abi: u8,

    /// ABI version.

    ///

    /// The meaning of this field depends on the `os_abi` value.

    pub abi_version: u8,

    /// Padding bytes.

    pub padding: [u8; 7],

}

/// File identification bytes stored in `Ident::magic`.

pub const ELFMAG: [u8; 4] = [0x7f, b'E', b'L', b'F'];

// Values for `Ident::class`.

/// Invalid class.

pub const ELFCLASSNONE: u8 = 0;

/// 32-bit object.

pub const ELFCLASS32: u8 = 1;

/// 64-bit object.

pub const ELFCLASS64: u8 = 2;

// Values for `Ident::data`.

/// Invalid data encoding.

pub const ELFDATANONE: u8 = 0;

/// 2's complement, little endian.

pub const ELFDATA2LSB: u8 = 1;

/// 2's complement, big endian.

pub const ELFDATA2MSB: u8 = 2;

// Values for `Ident::os_abi`.

/// UNIX System V ABI.

pub const ELFOSABI_NONE: u8 = 0;

/// UNIX System V ABI.

///

/// Alias.

pub const ELFOSABI_SYSV: u8 = 0;

/// HP-UX.

pub const ELFOSABI_HPUX: u8 = 1;

/// NetBSD.

pub const ELFOSABI_NETBSD: u8 = 2;

/// Object uses GNU ELF extensions.

pub const ELFOSABI_GNU: u8 = 3;

/// Object uses GNU ELF extensions.

///

/// Compatibility alias.

pub const ELFOSABI_LINUX: u8 = ELFOSABI_GNU;

/// GNU/Hurd.

pub const ELFOSABI_HURD: u8 = 4;

/// Sun Solaris.

pub const ELFOSABI_SOLARIS: u8 = 6;

/// IBM AIX.

pub const ELFOSABI_AIX: u8 = 7;

/// SGI Irix.

pub const ELFOSABI_IRIX: u8 = 8;

/// FreeBSD.

pub const ELFOSABI_FREEBSD: u8 = 9;

/// Compaq TRU64 UNIX.

pub const ELFOSABI_TRU64: u8 = 10;

/// Novell Modesto.

pub const ELFOSABI_MODESTO: u8 = 11;

/// OpenBSD.

pub const ELFOSABI_OPENBSD: u8 = 12;

/// OpenVMS.

pub const ELFOSABI_OPENVMS: u8 = 13;

/// Hewlett-Packard Non-Stop Kernel.

pub const ELFOSABI_NSK: u8 = 14;

/// AROS

pub const ELFOSABI_AROS: u8 = 15;

/// FenixOS

pub const ELFOSABI_FENIXOS: u8 = 16;

/// Nuxi CloudABI

pub const ELFOSABI_CLOUDABI: u8 = 17;

/// ARM EABI.

pub const ELFOSABI_ARM_AEABI: u8 = 64;

/// ARM.

pub const ELFOSABI_ARM: u8 = 97;

/// Standalone (embedded) application.

pub const ELFOSABI_STANDALONE: u8 = 255;

// Values for `FileHeader*::e_type`.

/// No file type.

pub const ET_NONE: u16 = 0;

/// Relocatable file.

pub const ET_REL: u16 = 1;

/// Executable file.

pub const ET_EXEC: u16 = 2;

/// Shared object file.

pub const ET_DYN: u16 = 3;

/// Core file.

pub const ET_CORE: u16 = 4;

/// OS-specific range start.

pub const ET_LOOS: u16 = 0xfe00;

/// OS-specific range end.

pub const ET_HIOS: u16 = 0xfeff;

/// Processor-specific range start.

pub const ET_LOPROC: u16 = 0xff00;

/// Processor-specific range end.

pub const ET_HIPROC: u16 = 0xffff;

// Values for `FileHeader*::e_machine`.

/// No machine

pub const EM_NONE: u16 = 0;

/// AT&T WE 32100

pub const EM_M32: u16 = 1;

/// SUN SPARC

pub const EM_SPARC: u16 = 2;

/// Intel 80386

pub const EM_386: u16 = 3;

/// Motorola m68k family

pub const EM_68K: u16 = 4;

/// Motorola m88k family

pub const EM_88K: u16 = 5;

/// Intel MCU

pub const EM_IAMCU: u16 = 6;

/// Intel 80860

pub const EM_860: u16 = 7;

/// MIPS R3000 big-endian

pub const EM_MIPS: u16 = 8;

/// IBM System/370

pub const EM_S370: u16 = 9;

/// MIPS R3000 little-endian

pub const EM_MIPS_RS3_LE: u16 = 10;

/// HPPA

pub const EM_PARISC: u16 = 15;

/// Fujitsu VPP500

pub const EM_VPP500: u16 = 17;

/// Sun's "v8plus"

pub const EM_SPARC32PLUS: u16 = 18;

/// Intel 80960

pub const EM_960: u16 = 19;

/// PowerPC

pub const EM_PPC: u16 = 20;

/// PowerPC 64-bit

pub const EM_PPC64: u16 = 21;

/// IBM S390

pub const EM_S390: u16 = 22;

/// IBM SPU/SPC

pub const EM_SPU: u16 = 23;

/// NEC V800 series

pub const EM_V800: u16 = 36;

/// Fujitsu FR20

pub const EM_FR20: u16 = 37;

/// TRW RH-32

pub const EM_RH32: u16 = 38;

/// Motorola RCE

pub const EM_RCE: u16 = 39;

/// ARM

pub const EM_ARM: u16 = 40;

/// Digital Alpha

pub const EM_FAKE_ALPHA: u16 = 41;

/// Hitachi SH

pub const EM_SH: u16 = 42;

/// SPARC v9 64-bit

pub const EM_SPARCV9: u16 = 43;

/// Siemens Tricore

pub const EM_TRICORE: u16 = 44;

/// Argonaut RISC Core

pub const EM_ARC: u16 = 45;

/// Hitachi H8/300

pub const EM_H8_300: u16 = 46;

/// Hitachi H8/300H

pub const EM_H8_300H: u16 = 47;

/// Hitachi H8S

pub const EM_H8S: u16 = 48;

/// Hitachi H8/500

pub const EM_H8_500: u16 = 49;

/// Intel Merced

pub const EM_IA_64: u16 = 50;

/// Stanford MIPS-X

pub const EM_MIPS_X: u16 = 51;

/// Motorola Coldfire

pub const EM_COLDFIRE: u16 = 52;

/// Motorola M68HC12

pub const EM_68HC12: u16 = 53;

/// Fujitsu MMA Multimedia Accelerator

pub const EM_MMA: u16 = 54;

/// Siemens PCP

pub const EM_PCP: u16 = 55;

/// Sony nCPU embeeded RISC

pub const EM_NCPU: u16 = 56;

/// Denso NDR1 microprocessor

pub const EM_NDR1: u16 = 57;

/// Motorola Start*Core processor

pub const EM_STARCORE: u16 = 58;

/// Toyota ME16 processor

pub const EM_ME16: u16 = 59;

/// STMicroelectronic ST100 processor

pub const EM_ST100: u16 = 60;

/// Advanced Logic Corp. Tinyj emb.fam

pub const EM_TINYJ: u16 = 61;

/// AMD x86-64 architecture

pub const EM_X86_64: u16 = 62;

/// Sony DSP Processor

pub const EM_PDSP: u16 = 63;

/// Digital PDP-10

pub const EM_PDP10: u16 = 64;

/// Digital PDP-11

pub const EM_PDP11: u16 = 65;

/// Siemens FX66 microcontroller

pub const EM_FX66: u16 = 66;

/// STMicroelectronics ST9+ 8/16 mc

pub const EM_ST9PLUS: u16 = 67;

/// STmicroelectronics ST7 8 bit mc

pub const EM_ST7: u16 = 68;

/// Motorola MC68HC16 microcontroller

pub const EM_68HC16: u16 = 69;

/// Motorola MC68HC11 microcontroller

pub const EM_68HC11: u16 = 70;

/// Motorola MC68HC08 microcontroller

pub const EM_68HC08: u16 = 71;

/// Motorola MC68HC05 microcontroller

pub const EM_68HC05: u16 = 72;

/// Silicon Graphics SVx

pub const EM_SVX: u16 = 73;

/// STMicroelectronics ST19 8 bit mc

pub const EM_ST19: u16 = 74;

/// Digital VAX

pub const EM_VAX: u16 = 75;

/// Axis Communications 32-bit emb.proc

pub const EM_CRIS: u16 = 76;

/// Infineon Technologies 32-bit emb.proc

pub const EM_JAVELIN: u16 = 77;

/// Element 14 64-bit DSP Processor

pub const EM_FIREPATH: u16 = 78;

/// LSI Logic 16-bit DSP Processor

pub const EM_ZSP: u16 = 79;

/// Donald Knuth's educational 64-bit proc

pub const EM_MMIX: u16 = 80;

/// Harvard University machine-independent object files

pub const EM_HUANY: u16 = 81;

/// SiTera Prism

pub const EM_PRISM: u16 = 82;

/// Atmel AVR 8-bit microcontroller

pub const EM_AVR: u16 = 83;

/// Fujitsu FR30

pub const EM_FR30: u16 = 84;

/// Mitsubishi D10V

pub const EM_D10V: u16 = 85;

/// Mitsubishi D30V

pub const EM_D30V: u16 = 86;

/// NEC v850

pub const EM_V850: u16 = 87;

/// Mitsubishi M32R

pub const EM_M32R: u16 = 88;

/// Matsushita MN10300

pub const EM_MN10300: u16 = 89;

/// Matsushita MN10200

pub const EM_MN10200: u16 = 90;

/// picoJava

pub const EM_PJ: u16 = 91;

/// OpenRISC 32-bit embedded processor

pub const EM_OPENRISC: u16 = 92;

/// ARC International ARCompact

pub const EM_ARC_COMPACT: u16 = 93;

/// Tensilica Xtensa Architecture

pub const EM_XTENSA: u16 = 94;

/// Alphamosaic VideoCore

pub const EM_VIDEOCORE: u16 = 95;

/// Thompson Multimedia General Purpose Proc

pub const EM_TMM_GPP: u16 = 96;

/// National Semi. 32000

pub const EM_NS32K: u16 = 97;

/// Tenor Network TPC

pub const EM_TPC: u16 = 98;

/// Trebia SNP 1000

pub const EM_SNP1K: u16 = 99;

/// STMicroelectronics ST200

pub const EM_ST200: u16 = 100;

/// Ubicom IP2xxx

pub const EM_IP2K: u16 = 101;

/// MAX processor

pub const EM_MAX: u16 = 102;

/// National Semi. CompactRISC

pub const EM_CR: u16 = 103;

/// Fujitsu F2MC16

pub const EM_F2MC16: u16 = 104;

/// Texas Instruments msp430

pub const EM_MSP430: u16 = 105;

/// Analog Devices Blackfin DSP

pub const EM_BLACKFIN: u16 = 106;

/// Seiko Epson S1C33 family

pub const EM_SE_C33: u16 = 107;

/// Sharp embedded microprocessor

pub const EM_SEP: u16 = 108;

/// Arca RISC

pub const EM_ARCA: u16 = 109;

/// PKU-Unity & MPRC Peking Uni. mc series

pub const EM_UNICORE: u16 = 110;

/// eXcess configurable cpu

pub const EM_EXCESS: u16 = 111;

/// Icera Semi. Deep Execution Processor

pub const EM_DXP: u16 = 112;

/// Altera Nios II

pub const EM_ALTERA_NIOS2: u16 = 113;

/// National Semi. CompactRISC CRX

pub const EM_CRX: u16 = 114;

/// Motorola XGATE

pub const EM_XGATE: u16 = 115;

/// Infineon C16x/XC16x

pub const EM_C166: u16 = 116;

/// Renesas M16C

pub const EM_M16C: u16 = 117;

/// Microchip Technology dsPIC30F

pub const EM_DSPIC30F: u16 = 118;

/// Freescale Communication Engine RISC

pub const EM_CE: u16 = 119;

/// Renesas M32C

pub const EM_M32C: u16 = 120;

/// Altium TSK3000

pub const EM_TSK3000: u16 = 131;

/// Freescale RS08

pub const EM_RS08: u16 = 132;

/// Analog Devices SHARC family

pub const EM_SHARC: u16 = 133;

/// Cyan Technology eCOG2

pub const EM_ECOG2: u16 = 134;

/// Sunplus S+core7 RISC

pub const EM_SCORE7: u16 = 135;

/// New Japan Radio (NJR) 24-bit DSP

pub const EM_DSP24: u16 = 136;

/// Broadcom VideoCore III

pub const EM_VIDEOCORE3: u16 = 137;

/// RISC for Lattice FPGA

pub const EM_LATTICEMICO32: u16 = 138;

/// Seiko Epson C17

pub const EM_SE_C17: u16 = 139;

/// Texas Instruments TMS320C6000 DSP

pub const EM_TI_C6000: u16 = 140;

/// Texas Instruments TMS320C2000 DSP

pub const EM_TI_C2000: u16 = 141;

/// Texas Instruments TMS320C55x DSP

pub const EM_TI_C5500: u16 = 142;

/// Texas Instruments App. Specific RISC

pub const EM_TI_ARP32: u16 = 143;

/// Texas Instruments Prog. Realtime Unit

pub const EM_TI_PRU: u16 = 144;

/// STMicroelectronics 64bit VLIW DSP

pub const EM_MMDSP_PLUS: u16 = 160;

/// Cypress M8C

pub const EM_CYPRESS_M8C: u16 = 161;

/// Renesas R32C

pub const EM_R32C: u16 = 162;

/// NXP Semi. TriMedia

pub const EM_TRIMEDIA: u16 = 163;

/// QUALCOMM Hexagon

pub const EM_HEXAGON: u16 = 164;

/// Intel 8051 and variants

pub const EM_8051: u16 = 165;

/// STMicroelectronics STxP7x

pub const EM_STXP7X: u16 = 166;

/// Andes Tech. compact code emb. RISC

pub const EM_NDS32: u16 = 167;

/// Cyan Technology eCOG1X

pub const EM_ECOG1X: u16 = 168;

/// Dallas Semi. MAXQ30 mc

pub const EM_MAXQ30: u16 = 169;

/// New Japan Radio (NJR) 16-bit DSP

pub const EM_XIMO16: u16 = 170;

/// M2000 Reconfigurable RISC

pub const EM_MANIK: u16 = 171;

/// Cray NV2 vector architecture

pub const EM_CRAYNV2: u16 = 172;

/// Renesas RX

pub const EM_RX: u16 = 173;

/// Imagination Tech. META

pub const EM_METAG: u16 = 174;

/// MCST Elbrus

pub const EM_MCST_ELBRUS: u16 = 175;

/// Cyan Technology eCOG16

pub const EM_ECOG16: u16 = 176;

/// National Semi. CompactRISC CR16

pub const EM_CR16: u16 = 177;

/// Freescale Extended Time Processing Unit

pub const EM_ETPU: u16 = 178;

/// Infineon Tech. SLE9X

pub const EM_SLE9X: u16 = 179;

/// Intel L10M

pub const EM_L10M: u16 = 180;

/// Intel K10M

pub const EM_K10M: u16 = 181;

/// ARM AARCH64

pub const EM_AARCH64: u16 = 183;

/// Amtel 32-bit microprocessor

pub const EM_AVR32: u16 = 185;

/// STMicroelectronics STM8

pub const EM_STM8: u16 = 186;

/// Tileta TILE64

pub const EM_TILE64: u16 = 187;

/// Tilera TILEPro

pub const EM_TILEPRO: u16 = 188;

/// Xilinx MicroBlaze

pub const EM_MICROBLAZE: u16 = 189;

/// NVIDIA CUDA

pub const EM_CUDA: u16 = 190;

/// Tilera TILE-Gx

pub const EM_TILEGX: u16 = 191;

/// CloudShield

pub const EM_CLOUDSHIELD: u16 = 192;

/// KIPO-KAIST Core-A 1st gen.

pub const EM_COREA_1ST: u16 = 193;

/// KIPO-KAIST Core-A 2nd gen.

pub const EM_COREA_2ND: u16 = 194;

/// Synopsys ARCompact V2

pub const EM_ARC_COMPACT2: u16 = 195;

/// Open8 RISC

pub const EM_OPEN8: u16 = 196;

/// Renesas RL78

pub const EM_RL78: u16 = 197;

/// Broadcom VideoCore V

pub const EM_VIDEOCORE5: u16 = 198;

/// Renesas 78KOR

pub const EM_78KOR: u16 = 199;

/// Freescale 56800EX DSC

pub const EM_56800EX: u16 = 200;

/// Beyond BA1

pub const EM_BA1: u16 = 201;

/// Beyond BA2

pub const EM_BA2: u16 = 202;

/// XMOS xCORE

pub const EM_XCORE: u16 = 203;

/// Microchip 8-bit PIC(r)

pub const EM_MCHP_PIC: u16 = 204;

/// KM211 KM32

pub const EM_KM32: u16 = 210;

/// KM211 KMX32

pub const EM_KMX32: u16 = 211;

/// KM211 KMX16

pub const EM_EMX16: u16 = 212;

/// KM211 KMX8

pub const EM_EMX8: u16 = 213;

/// KM211 KVARC

pub const EM_KVARC: u16 = 214;

/// Paneve CDP

pub const EM_CDP: u16 = 215;

/// Cognitive Smart Memory Processor

pub const EM_COGE: u16 = 216;

/// Bluechip CoolEngine

pub const EM_COOL: u16 = 217;

/// Nanoradio Optimized RISC

pub const EM_NORC: u16 = 218;

/// CSR Kalimba

pub const EM_CSR_KALIMBA: u16 = 219;

/// Zilog Z80

pub const EM_Z80: u16 = 220;

/// Controls and Data Services VISIUMcore

pub const EM_VISIUM: u16 = 221;

/// FTDI Chip FT32

pub const EM_FT32: u16 = 222;

/// Moxie processor

pub const EM_MOXIE: u16 = 223;

/// AMD GPU

pub const EM_AMDGPU: u16 = 224;

/// RISC-V

pub const EM_RISCV: u16 = 243;

/// Linux BPF -- in-kernel virtual machine

pub const EM_BPF: u16 = 247;

/// C-SKY

pub const EM_CSKY: u16 = 252;

/// Loongson LoongArch

pub const EM_LOONGARCH: u16 = 258;

/// Solana Binary Format

pub const EM_SBF: u16 = 263;

/// Digital Alpha

pub const EM_ALPHA: u16 = 0x9026;

// Values for `FileHeader*::e_version` and `Ident::version`.

/// Invalid ELF version.

pub const EV_NONE: u8 = 0;

/// Current ELF version.

pub const EV_CURRENT: u8 = 1;

/// Section header.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct SectionHeader32<E: Endian> {

    /// Section name.

    ///

    /// This is an offset into the section header string table.

    pub sh_name: U32<E>,

    /// Section type. One of the `SHT_*` constants.

    pub sh_type: U32<E>,

    /// Section flags. A combination of the `SHF_*` constants.

    pub sh_flags: U32<E>,

    /// Section virtual address at execution.

    pub sh_addr: U32<E>,

    /// Section file offset.

    pub sh_offset: U32<E>,

    /// Section size in bytes.

    pub sh_size: U32<E>,

    /// Link to another section.

    ///

    /// The section relationship depends on the `sh_type` value.

    pub sh_link: U32<E>,

    /// Additional section information.

    ///

    /// The meaning of this field depends on the `sh_type` value.

    pub sh_info: U32<E>,

    /// Section alignment.

    pub sh_addralign: U32<E>,

    /// Entry size if the section holds a table.

    pub sh_entsize: U32<E>,

}

/// Section header.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct SectionHeader64<E: Endian> {

    /// Section name.

    ///

    /// This is an offset into the section header string table.

    pub sh_name: U32<E>,

    /// Section type. One of the `SHT_*` constants.

    pub sh_type: U32<E>,

    /// Section flags. A combination of the `SHF_*` constants.

    pub sh_flags: U64<E>,

    /// Section virtual address at execution.

    pub sh_addr: U64<E>,

    /// Section file offset.

    pub sh_offset: U64<E>,

    /// Section size in bytes.

    pub sh_size: U64<E>,

    /// Link to another section.

    ///

    /// The section relationship depends on the `sh_type` value.

    pub sh_link: U32<E>,

    /// Additional section information.

    ///

    /// The meaning of this field depends on the `sh_type` value.

    pub sh_info: U32<E>,

    /// Section alignment.

    pub sh_addralign: U64<E>,

    /// Entry size if the section holds a table.

    pub sh_entsize: U64<E>,

}

// Special values for section indices.

/// Undefined section.

pub const SHN_UNDEF: u16 = 0;

/// OS-specific range start.

/// Start of reserved section indices.

pub const SHN_LORESERVE: u16 = 0xff00;

/// Start of processor-specific section indices.

pub const SHN_LOPROC: u16 = 0xff00;

/// End of processor-specific section indices.

pub const SHN_HIPROC: u16 = 0xff1f;

/// Start of OS-specific section indices.

pub const SHN_LOOS: u16 = 0xff20;

/// End of OS-specific section indices.

pub const SHN_HIOS: u16 = 0xff3f;

/// Associated symbol is absolute.

pub const SHN_ABS: u16 = 0xfff1;

/// Associated symbol is common.

pub const SHN_COMMON: u16 = 0xfff2;

/// Section index is in the `SHT_SYMTAB_SHNDX` section.

pub const SHN_XINDEX: u16 = 0xffff;

/// End of reserved section indices.

pub const SHN_HIRESERVE: u16 = 0xffff;

// Values for `SectionHeader*::sh_type`.

/// Section header table entry is unused.

pub const SHT_NULL: u32 = 0;

/// Program data.

pub const SHT_PROGBITS: u32 = 1;

/// Symbol table.

pub const SHT_SYMTAB: u32 = 2;

/// String table.

pub const SHT_STRTAB: u32 = 3;

/// Relocation entries with explicit addends.

pub const SHT_RELA: u32 = 4;

/// Symbol hash table.

pub const SHT_HASH: u32 = 5;

/// Dynamic linking information.

pub const SHT_DYNAMIC: u32 = 6;

/// Notes.

pub const SHT_NOTE: u32 = 7;

/// Program space with no data (bss).

pub const SHT_NOBITS: u32 = 8;

/// Relocation entries without explicit addends.

pub const SHT_REL: u32 = 9;

/// Reserved section type.

pub const SHT_SHLIB: u32 = 10;

/// Dynamic linker symbol table.

pub const SHT_DYNSYM: u32 = 11;

/// Array of constructors.

pub const SHT_INIT_ARRAY: u32 = 14;

/// Array of destructors.

pub const SHT_FINI_ARRAY: u32 = 15;

/// Array of pre-constructors.

pub const SHT_PREINIT_ARRAY: u32 = 16;

/// Section group.

pub const SHT_GROUP: u32 = 17;

/// Extended section indices for a symbol table.

pub const SHT_SYMTAB_SHNDX: u32 = 18;

/// Start of OS-specific section types.

pub const SHT_LOOS: u32 = 0x6000_0000;

/// Object attributes.

pub const SHT_GNU_ATTRIBUTES: u32 = 0x6fff_fff5;

/// GNU-style hash table.

pub const SHT_GNU_HASH: u32 = 0x6fff_fff6;

/// Prelink library list

pub const SHT_GNU_LIBLIST: u32 = 0x6fff_fff7;

/// Checksum for DSO content.

pub const SHT_CHECKSUM: u32 = 0x6fff_fff8;

/// Sun-specific low bound.

pub const SHT_LOSUNW: u32 = 0x6fff_fffa;

#[allow(missing_docs, non_upper_case_globals)]

pub const SHT_SUNW_move: u32 = 0x6fff_fffa;

#[allow(missing_docs)]

pub const SHT_SUNW_COMDAT: u32 = 0x6fff_fffb;

#[allow(missing_docs, non_upper_case_globals)]

pub const SHT_SUNW_syminfo: u32 = 0x6fff_fffc;

/// Version definition section.

#[allow(non_upper_case_globals)]

pub const SHT_GNU_VERDEF: u32 = 0x6fff_fffd;

/// Version needs section.

#[allow(non_upper_case_globals)]

pub const SHT_GNU_VERNEED: u32 = 0x6fff_fffe;

/// Version symbol table.

#[allow(non_upper_case_globals)]

pub const SHT_GNU_VERSYM: u32 = 0x6fff_ffff;

/// Sun-specific high bound.

pub const SHT_HISUNW: u32 = 0x6fff_ffff;

/// End of OS-specific section types.

pub const SHT_HIOS: u32 = 0x6fff_ffff;

/// Start of processor-specific section types.

pub const SHT_LOPROC: u32 = 0x7000_0000;

/// End of processor-specific section types.

pub const SHT_HIPROC: u32 = 0x7fff_ffff;

/// Start of application-specific section types.

pub const SHT_LOUSER: u32 = 0x8000_0000;

/// End of application-specific section types.

pub const SHT_HIUSER: u32 = 0x8fff_ffff;

// Values for `SectionHeader*::sh_flags`.

/// Section is writable.

pub const SHF_WRITE: u32 = 1 << 0;

/// Section occupies memory during execution.

pub const SHF_ALLOC: u32 = 1 << 1;

/// Section is executable.

pub const SHF_EXECINSTR: u32 = 1 << 2;

/// Section may be be merged to eliminate duplication.

pub const SHF_MERGE: u32 = 1 << 4;

/// Section contains nul-terminated strings.

pub const SHF_STRINGS: u32 = 1 << 5;

/// The `sh_info` field contains a section header table index.

pub const SHF_INFO_LINK: u32 = 1 << 6;

/// Section has special ordering requirements when combining sections.

pub const SHF_LINK_ORDER: u32 = 1 << 7;

/// Section requires special OS-specific handling.

pub const SHF_OS_NONCONFORMING: u32 = 1 << 8;

/// Section is a member of a group.

pub const SHF_GROUP: u32 = 1 << 9;

/// Section holds thread-local storage.

pub const SHF_TLS: u32 = 1 << 10;

/// Section is compressed.

///

/// Compressed sections begin with one of the `CompressionHeader*` headers.

pub const SHF_COMPRESSED: u32 = 1 << 11;

/// OS-specific section flags.

pub const SHF_MASKOS: u32 = 0x0ff0_0000;

/// Processor-specific section flags.

pub const SHF_MASKPROC: u32 = 0xf000_0000;

/// This section is excluded from the final executable or shared library.

pub const SHF_EXCLUDE: u32 = 0x8000_0000;

/// Section compression header.

///

/// Used when `SHF_COMPRESSED` is set.

///

/// Note: this type currently allows for misaligned headers, but that may be

/// changed in a future version.

#[derive(Debug, Default, Clone, Copy)]

#[repr(C)]

pub struct CompressionHeader32<E: Endian> {

    /// Compression format. One of the `ELFCOMPRESS_*` values.

    pub ch_type: U32Bytes<E>,

    /// Uncompressed data size.

    pub ch_size: U32Bytes<E>,

    /// Uncompressed data alignment.

    pub ch_addralign: U32Bytes<E>,

}

/// Section compression header.

///

/// Used when `SHF_COMPRESSED` is set.

///

/// Note: this type currently allows for misaligned headers, but that may be

/// changed in a future version.

#[derive(Debug, Default, Clone, Copy)]

#[repr(C)]

pub struct CompressionHeader64<E: Endian> {

    /// Compression format. One of the `ELFCOMPRESS_*` values.

    pub ch_type: U32Bytes<E>,

    /// Reserved.

    pub ch_reserved: U32Bytes<E>,

    /// Uncompressed data size.

    pub ch_size: U64Bytes<E>,

    /// Uncompressed data alignment.

    pub ch_addralign: U64Bytes<E>,

}

/// ZLIB/DEFLATE algorithm.

pub const ELFCOMPRESS_ZLIB: u32 = 1;

/// Start of OS-specific compression types.

pub const ELFCOMPRESS_LOOS: u32 = 0x6000_0000;

/// End of OS-specific compression types.

pub const ELFCOMPRESS_HIOS: u32 = 0x6fff_ffff;

/// Start of processor-specific compression types.

pub const ELFCOMPRESS_LOPROC: u32 = 0x7000_0000;

/// End of processor-specific compression types.

pub const ELFCOMPRESS_HIPROC: u32 = 0x7fff_ffff;

// Values for the flag entry for section groups.

/// Mark group as COMDAT.

pub const GRP_COMDAT: u32 = 1;

/// Symbol table entry.

#[derive(Debug, Default, Clone, Copy)]

#[repr(C)]

pub struct Sym32<E: Endian> {

    /// Symbol name.

    ///

    /// This is an offset into the symbol string table.

    pub st_name: U32<E>,

    /// Symbol value.

    pub st_value: U32<E>,

    /// Symbol size.

    pub st_size: U32<E>,

    /// Symbol type and binding.

    ///

    /// Use the `st_type` and `st_bind` methods to access this value.

    pub st_info: u8,

    /// Symbol visibility.

    ///

    /// Use the `st_visibility` method to access this value.

    pub st_other: u8,

    /// Section index or one of the `SHN_*` values.

    pub st_shndx: U16<E>,

}

impl<E: Endian> Sym32<E> {

    /// Get the `st_bind` component of the `st_info` field.

    #[inline]

    /// Get the `st_type` component of the `st_info` field.

    #[inline]

    /// Set the `st_info` field given the `st_bind` and `st_type` components.

    #[inline]

    /// Get the `st_visibility` component of the `st_info` field.

    #[inline]

}

/// Symbol table entry.

#[derive(Debug, Default, Clone, Copy)]

#[repr(C)]

pub struct Sym64<E: Endian> {

    /// Symbol name.

    ///

    /// This is an offset into the symbol string table.

    pub st_name: U32<E>,

    /// Symbol type and binding.

    ///

    /// Use the `st_bind` and `st_type` methods to access this value.

    pub st_info: u8,

    /// Symbol visibility.

    ///

    /// Use the `st_visibility` method to access this value.

    pub st_other: u8,

    /// Section index or one of the `SHN_*` values.

    pub st_shndx: U16<E>,

    /// Symbol value.

    pub st_value: U64<E>,

    /// Symbol size.

    pub st_size: U64<E>,

}

impl<E: Endian> Sym64<E> {

    /// Get the `st_bind` component of the `st_info` field.

    #[inline]

    /// Get the `st_type` component of the `st_info` field.

    #[inline]

    /// Set the `st_info` field given the `st_bind` and `st_type` components.

    #[inline]

    /// Get the `st_visibility` component of the `st_info` field.

    #[inline]

}

/// Additional information about a `Sym32`.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Syminfo32<E: Endian> {

    /// Direct bindings, symbol bound to.

    pub si_boundto: U16<E>,

    /// Per symbol flags.

    pub si_flags: U16<E>,

}

/// Additional information about a `Sym64`.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Syminfo64<E: Endian> {

    /// Direct bindings, symbol bound to.

    pub si_boundto: U16<E>,

    /// Per symbol flags.

    pub si_flags: U16<E>,

}

// Values for `Syminfo*::si_boundto`.

/// Symbol bound to self

pub const SYMINFO_BT_SELF: u16 = 0xffff;

/// Symbol bound to parent

pub const SYMINFO_BT_PARENT: u16 = 0xfffe;

/// Beginning of reserved entries

pub const SYMINFO_BT_LOWRESERVE: u16 = 0xff00;

// Values for `Syminfo*::si_flags`.

/// Direct bound symbol

pub const SYMINFO_FLG_DIRECT: u16 = 0x0001;

/// Pass-thru symbol for translator

pub const SYMINFO_FLG_PASSTHRU: u16 = 0x0002;

/// Symbol is a copy-reloc

pub const SYMINFO_FLG_COPY: u16 = 0x0004;

/// Symbol bound to object to be lazy loaded

pub const SYMINFO_FLG_LAZYLOAD: u16 = 0x0008;

// Syminfo version values.

#[allow(missing_docs)]

pub const SYMINFO_NONE: u16 = 0;

#[allow(missing_docs)]

pub const SYMINFO_CURRENT: u16 = 1;

#[allow(missing_docs)]

pub const SYMINFO_NUM: u16 = 2;

// Values for bind component of `Sym*::st_info`.

/// Local symbol.

pub const STB_LOCAL: u8 = 0;

/// Global symbol.

pub const STB_GLOBAL: u8 = 1;

/// Weak symbol.

pub const STB_WEAK: u8 = 2;

/// Start of OS-specific symbol binding.

pub const STB_LOOS: u8 = 10;

/// Unique symbol.

pub const STB_GNU_UNIQUE: u8 = 10;

/// End of OS-specific symbol binding.

pub const STB_HIOS: u8 = 12;

/// Start of processor-specific symbol binding.

pub const STB_LOPROC: u8 = 13;

/// End of processor-specific symbol binding.

pub const STB_HIPROC: u8 = 15;

// Values for type component of `Sym*::st_info`.

/// Symbol type is unspecified.

pub const STT_NOTYPE: u8 = 0;

/// Symbol is a data object.

pub const STT_OBJECT: u8 = 1;

/// Symbol is a code object.

pub const STT_FUNC: u8 = 2;

/// Symbol is associated with a section.

pub const STT_SECTION: u8 = 3;

/// Symbol's name is a file name.

pub const STT_FILE: u8 = 4;

/// Symbol is a common data object.

pub const STT_COMMON: u8 = 5;

/// Symbol is a thread-local storage object.

pub const STT_TLS: u8 = 6;

/// Start of OS-specific symbol types.

pub const STT_LOOS: u8 = 10;

/// Symbol is an indirect code object.

pub const STT_GNU_IFUNC: u8 = 10;

/// End of OS-specific symbol types.

pub const STT_HIOS: u8 = 12;

/// Start of processor-specific symbol types.

pub const STT_LOPROC: u8 = 13;

/// End of processor-specific symbol types.

pub const STT_HIPROC: u8 = 15;

// Values for visibility component of `Symbol*::st_other`.

/// Default symbol visibility rules.

pub const STV_DEFAULT: u8 = 0;

/// Processor specific hidden class.

pub const STV_INTERNAL: u8 = 1;

/// Symbol is not visible to other components.

pub const STV_HIDDEN: u8 = 2;

/// Symbol is visible to other components, but is not preemptible.

pub const STV_PROTECTED: u8 = 3;

/// Relocation table entry without explicit addend.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Rel32<E: Endian> {

    /// Relocation address.

    pub r_offset: U32<E>,

    /// Relocation type and symbol index.

    pub r_info: U32<E>,

}

impl<E: Endian> Rel32<E> {

    /// Get the `r_sym` component of the `r_info` field.

    #[inline]

    /// Get the `r_type` component of the `r_info` field.

    #[inline]

    /// Calculate the `r_info` field given the `r_sym` and `r_type` components.

    /// Set the `r_info` field given the `r_sym` and `r_type` components.

}

/// Relocation table entry with explicit addend.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Rela32<E: Endian> {

    /// Relocation address.

    pub r_offset: U32<E>,

    /// Relocation type and symbol index.

    pub r_info: U32<E>,

    /// Explicit addend.

    pub r_addend: I32<E>,

}

impl<E: Endian> Rela32<E> {

    /// Get the `r_sym` component of the `r_info` field.

    #[inline]

    /// Get the `r_type` component of the `r_info` field.

    #[inline]

    /// Calculate the `r_info` field given the `r_sym` and `r_type` components.

    /// Set the `r_info` field given the `r_sym` and `r_type` components.

}

impl<E: Endian> From<Rel32<E>> for Rela32<E> {

}

/// Relocation table entry without explicit addend.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Rel64<E: Endian> {

    /// Relocation address.

    pub r_offset: U64<E>,

    /// Relocation type and symbol index.

    pub r_info: U64<E>,

}

impl<E: Endian> Rel64<E> {

    /// Get the `r_sym` component of the `r_info` field.

    #[inline]

    /// Get the `r_type` component of the `r_info` field.

    #[inline]

    /// Calculate the `r_info` field given the `r_sym` and `r_type` components.

    /// Set the `r_info` field given the `r_sym` and `r_type` components.

}

impl<E: Endian> From<Rel64<E>> for Rela64<E> {

}

/// Relocation table entry with explicit addend.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct Rela64<E: Endian> {

    /// Relocation address.

    pub r_offset: U64<E>,

    /// Relocation type and symbol index.

    pub r_info: U64<E>,

    /// Explicit addend.

    pub r_addend: I64<E>,

}

impl<E: Endian> Rela64<E> {

    /// Get the `r_sym` component of the `r_info` field.

    #[inline]

    /// Get the `r_type` component of the `r_info` field.

    #[inline]

    /// Calculate the `r_info` field given the `r_sym` and `r_type` components.

    /// Set the `r_info` field given the `r_sym` and `r_type` components.

}

/// Program segment header.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct ProgramHeader32<E: Endian> {

    /// Segment type. One of the `PT_*` constants.

    pub p_type: U32<E>,

    /// Segment file offset.

    pub p_offset: U32<E>,

    /// Segment virtual address.

    pub p_vaddr: U32<E>,

    /// Segment physical address.

    pub p_paddr: U32<E>,

    /// Segment size in the file.

    pub p_filesz: U32<E>,

    /// Segment size in memory.

    pub p_memsz: U32<E>,

    /// Segment flags. A combination of the `PF_*` constants.

    pub p_flags: U32<E>,

    /// Segment alignment.

    pub p_align: U32<E>,

}

/// Program segment header.

#[derive(Debug, Clone, Copy)]

#[repr(C)]

pub struct ProgramHeader64<E: Endian> {

    /// Segment type. One of the `PT_*` constants.

    pub p_type: U32<E>,

    /// Segment flags. A combination of the `PF_*` constants.

    pub p_flags: U32<E>,

    /// Segment file offset.

    pub p_offset: U64<E>,

    /// Segment virtual address.

    pub p_vaddr: U64<E>,

    /// Segment physical address.

    pub p_paddr: U64<E>,

    /// Segment size in the file.

    pub p_filesz: U64<E>,

    /// Segment size in memory.

    pub p_memsz: U64<E>,

    /// Segment alignment.

    pub p_align: U64<E>,

}

/// Special value for `FileHeader*::e_phnum`.

///

/// This indicates that the real number of program headers is too large to fit into e_phnum.

/// Instead the real value is in the field `sh_info` of section 0.

pub const PN_XNUM: u16 = 0xffff;

// Values for `ProgramHeader*::p_type`.

/// Program header table entry is unused.

pub const PT_NULL: u32 = 0;

/// Loadable program segment.

pub const PT_LOAD: u32 = 1;

/// Dynamic linking information.

pub const PT_DYNAMIC: u32 = 2;

/// Program interpreter.

pub const PT_INTERP: u32 = 3;

/// Auxiliary information.

pub const PT_NOTE: u32 = 4;

/// Reserved.

pub const PT_SHLIB: u32 = 5;

/// Segment contains the program header table.

pub const PT_PHDR: u32 = 6;

/// Thread-local storage segment.

pub const PT_TLS: u32 = 7;

/// Start of OS-specific segment types.

pub const PT_LOOS: u32 = 0x6000_0000;

/// GCC `.eh_frame_hdr` segment.

pub const PT_GNU_EH_FRAME: u32 = 0x6474_e550;

/// Indicates stack executability.

pub const PT_GNU_STACK: u32 = 0x6474_e551;

/// Read-only after relocation.

pub const PT_GNU_RELRO: u32 = 0x6474_e552;

/// End of OS-specific segment types.

pub const PT_HIOS: u32 = 0x6fff_ffff;

/// Start of processor-specific segment types.

pub const PT_LOPROC: u32 = 0x7000_0000;

/// End of processor-specific segment types.

pub const PT_HIPROC: u32 = 0x7fff_ffff;

// Values for `ProgramHeader*::p_flags`.

/// Segment is executable.

pub const PF_X: u32 = 1 << 0;

/// Segment is writable.

pub const PF_W: u32 = 1 << 1;

/// Segment is readable.

pub const PF_R: u32 = 1 << 2;

/// OS-specific segment flags.

pub const PF_MASKOS: u32 = 0x0ff0_0000;

/// Processor-specific segment flags.

pub const PF_MASKPROC: u32 = 0xf000_0000;

/// Note name for core files.

pub static ELF_NOTE_CORE: &[u8] = b"CORE";

/// Note name for linux core files.

///

/// Notes in linux core files may also use `ELF_NOTE_CORE`.

pub static ELF_NOTE_LINUX: &[u8] = b"LINUX";

// Values for `NoteHeader*::n_type` in core files.

//

/// Contains copy of prstatus struct.

pub const NT_PRSTATUS: u32 = 1;

/// Contains copy of fpregset struct.

pub const NT_PRFPREG: u32 = 2;

/// Contains copy of fpregset struct.

pub const NT_FPREGSET: u32 = 2;

/// Contains copy of prpsinfo struct.

pub const NT_PRPSINFO: u32 = 3;

/// Contains copy of prxregset struct.

pub const NT_PRXREG: u32 = 4;

/// Contains copy of task structure.

pub const NT_TASKSTRUCT: u32 = 4;

/// String from sysinfo(SI_PLATFORM).

pub const NT_PLATFORM: u32 = 5;

/// Contains copy of auxv array.